Skip to content

[Dataflow Streaming] Fix race in GetDataStream that could leave get data requests orphaned on stream errors after half-closing. - #36401

Merged
Abacn merged 1 commit into
apache:masterfrom
scwhittle:get_data_race
Oct 6, 2025
Merged

[Dataflow Streaming] Fix race in GetDataStream that could leave get data requests orphaned on stream errors after half-closing.#36401
Abacn merged 1 commit into
apache:masterfrom
scwhittle:get_data_race

Conversation

@scwhittle

@scwhittle scwhittle commented Oct 6, 2025

Copy link
Copy Markdown
Contributor

This caused test flakiness of GetDataStreamTest.testRequestKeyedData_reconnectOnStreamErrorAfterHalfClose

Fixes #36347

Please add a meaningful description for your change here

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@scwhittle
[Dataflow Streaming] Fix race in GetDataStream that could leave get d…
c809f3a 
…ata requests orphaned on stream errors after half-closing.

This caused test flakiness of GetDataStreamTest.testRequestKeyedData_reconnectOnStreamErrorAfterHalfClose

Fixes apache#36347
@gemini-code-assist

gemini-code-assist Bot commented Oct 6, 2025

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @scwhittle, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical race condition within the Dataflow Streaming GetDataStream component. Previously, stream errors after a half-close could lead to data requests being orphaned, causing test flakiness and potential data processing issues. The changes ensure that all pending and queued requests are correctly identified and re-sent on new stream connections, significantly improving the reliability and robustness of data retrieval in streaming pipelines.

Highlights

  • Fix for Orphaned Requests: Corrected a race condition in GetDataStream where requests could become orphaned after a stream error and half-closing. This ensures all pending requests are properly handled and re-sent.
  • Improved Pending Request Detection: The hasPendingRequests() method now accurately accounts for both immediately pending requests and those queued for later processing, preventing requests from being overlooked.
  • Enhanced Stream Error Handling: Modified the trySendBatch logic to prevent sending batches if the client is closed, ensuring these batches are retained and re-sent on a new stream connection.
  • Test Flakiness Resolution: Updated GetDataStreamTest.testRequestKeyedData_reconnectOnStreamErrorAfterHalfClose to be more robust against race conditions during stream reconnection, addressing previous test flakiness.
  • Code Clarity Refinement: Renamed batchesDebugSizeSupplier to batchesSizeSupplier for better clarity regarding its purpose.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@scwhittle

scwhittle commented Oct 6, 2025

Copy link
Copy Markdown
Contributor Author

R: @arunpandianp

@github-actions

github-actions Bot commented Oct 6, 2025

Copy link
Copy Markdown
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

@Abacn

Abacn commented Oct 6, 2025

Copy link
Copy Markdown
Contributor

ran the tests locally

@Abacn
Abacn merged commit 1282e6c into apache:master Oct 6, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Abacn Abacn Abacn approved these changes

Assignees

No one assigned

Labels

dataflow runners

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Failing Test]: GrpcGetDataStreamTest flaky timeout

2 participants

@scwhittle @Abacn